/* ************************************************************************************
 * Copyright (c) 2010, FoxholeStudios
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, 
 * are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this list 
 * of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice, this 
 * list of conditions and the following disclaimer in the documentation and/or other 
 * materials provided with the distribution.
 * Neither the name of FoxholeStudios nor the names of its contributors may be used 
 * to endorse or promote products derived from this software without specific prior 
 * written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
 * SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 
 * DAMAGE.
 * ************************************************************************************/

package com.foxhole.tools.spartan.states;

import java.util.List;
import java.util.Map;

import com.foxhole.tools.spartan.exception.SpartanException;


/**
 * The abstract implementation of the basic Game State Object.
 * All the Spartan Game State Objects derive from this object.
 * 
 * @author Tiago "Spiegel" Costa
 */
public abstract class AbstractGameState implements IGameStateObject {

	protected static String IDENTIFIER	= "IDENTIFIER";
	
	/**
	 * The id for this Game State
	 */
	private String id;
	
	/** 
	 * Implements the basic Constructor for the Game State Object
	 * 
	 * @param id The id for this game state.
	 */
	public AbstractGameState(String id){
		setId(id);
	}
	
	/* (non-Javadoc)
	 * @see com.foxhole.tools.spartan.states.IGameStateObject#getId()
	 */
	public final String getId() {
		return id;
	}

	/* (non-Javadoc)
	 * @see com.foxhole.tools.spartan.states.IGameStateObject#setId(java.lang.String)
	 */
	public final void setId(String id) {
		this.id = id;
	}
	
	/**
	 * To use the Level Loader interface, all the Game States should implement the initialization of the 
	 * class via a map of parameter values.
	 * 
	 * @param stateDetails The values that will be used to fill the data of the class
	 * @return a new gamestate instance properly initialized 
	 * @throws SpartanException When an error occurs
	 */
	public static IGameStateObject initialize(Map<String, String> stateDetails) throws SpartanException{
		return null;
	}

	/**
	 * Obtains a list of string that represent the details that must be passed to the initialize method
	 * 
	 * @return the list of strings
	 */
	public static List<String> getStateDetails(){
		return null;
	}
}
